package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.EmpWorkRequireAddDTO;
import org.jsola.hr.dto.EmpWorkRequireUpdateDTO;
import org.jsola.hr.query.EmpWorkRequireQuery;
import org.jsola.hr.vo.EmpWorkRequireListVO;
import org.jsola.hr.vo.EmpWorkRequireVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-公司员工工作经历所需信息")
public interface IEmpWorkRequireControllerAPI {

    /**
     * 新增公司员工工作经历所需信息
     * @param empWorkRequireAddDTO 公司员工工作经历所需信息新增实体
     * @return 公司员工工作经历所需信息展示对象
     */
    @ApiOperation(value = "新增公司员工工作经历所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empWorkRequireAddDTO", dataType = "EmpWorkRequireAddDTO", value = "新增公司员工工作经历所需信息", paramType = "body")
    })
    Result<EmpWorkRequireVO> save(EmpWorkRequireAddDTO empWorkRequireAddDTO);


    /**
     * 修改公司员工工作经历所需信息
     * @param empWorkRequireUpdateDTO 公司员工工作经历所需信息
     * @return 更新数量
     */
    @ApiOperation(value = "修改公司员工工作经历所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empWorkRequireUpdateDTO", dataType = "EmpWorkRequireUpdateDTO", value = "修改公司员工工作经历所需信息", paramType = "body")
    })
    Result<Integer> update(EmpWorkRequireUpdateDTO empWorkRequireUpdateDTO);




    /**
     * 删除单个公司员工工作经历所需信息，彻底删除
     * @param empWorkRequireId 公司员工工作经历所需信息id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个公司员工工作经历所需信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empWorkRequireId", dataType = "String", value = "公司员工工作经历所需信息id", paramType = "path")
    })
    Result<Integer> delete(String empWorkRequireId);


    /**
     * 批量删除公司员工工作经历所需信息，彻底删除
     * @param empWorkRequireIds 公司员工工作经历所需信息id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除公司员工工作经历所需信息，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empWorkRequireIds", dataType = "String[]", value = "公司员工工作经历所需信息id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] empWorkRequireIds);


    /**
     * 根据公司员工工作经历所需信息id查询公司员工工作经历所需信息详情
     * @param empWorkRequireId 公司员工工作经历所需信息id
     * @return 公司员工工作经历所需信息详情
     */
    @ApiOperation(value="根据公司员工工作经历所需信息id查询公司员工工作经历所需信息详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empWorkRequireId", dataType = "String", value = "公司员工工作经历所需信息id", paramType = "path")
    })
    Result<EmpWorkRequireVO> findById(String empWorkRequireId);


    /**
     * 查询公司员工工作经历所需信息
     * @param empWorkRequireQuery 公司员工工作经历所需信息查询参数
     * @return page
     */
    @ApiOperation(value="查询公司员工工作经历所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empWorkRequireQuery", dataType = "EmpWorkRequireQuery", value = "公司员工工作经历所需信息查询参数", paramType = "query")
    })
    Result<List<EmpWorkRequireListVO>> listAll(EmpWorkRequireQuery empWorkRequireQuery);


     /**
     * 分页查询公司员工工作经历所需信息
     * @param empWorkRequireQuery 公司员工工作经历所需信息查询参数
     * @return page
     */
    @ApiOperation(value="分页查询公司员工工作经历所需信息")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "empWorkRequireQuery", dataType = "EmpWorkRequireQuery", value = "公司员工工作经历所需信息查询参数", paramType = "query")
    })
    Result<Page<EmpWorkRequireListVO>> page(EmpWorkRequireQuery empWorkRequireQuery);


}

